Operation Document.Query (Query)

In component org.nuxeo.ecm.core.automation.featuresContrib

Description

Perform a query on the repository. The document list returned will become the input for the next operation.

Operation id	Document.Query
Category	Fetch
Label	Query
Requires
Since	6.0

Parameters

Name	Type	Required	Default value
query	string	yes
currentPageIndex	integer	no
language	string	no	NXQL
namedParameters	properties	no
pageSize	integer	no
queryParams	stringlist	no
sortBy	string	no
sortOrder	string	no	ASC, DESC

Signature

Inputs	void
Outputs	documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.services.query.DocumentPaginatedQuery
Contributing Component	org.nuxeo.ecm.core.automation.featuresContrib

JSON Definition

{
  "id" : "Document.Query",
  "label" : "Query",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a query on the repository. The document list returned will become the input for the next operation.",
  "since" : "6.0",
  "url" : "Document.Query",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "name" : "query",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "currentPageIndex",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL" ]
  }, {
    "name" : "namedParameters",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortBy",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ]
}